home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 1 Issue 2 / PDCD-1 - Issue 02.iso / _utilities / utilities / 004 / _atool / Manual / Manual_1 next >
Text File  |  1994-09-29  |  9KB  |  192 lines
  1.                                 "ATOOL Manual" (!Brief!)
  2.                                 ------------------------
  3.  
  4.  
  5. 1. General description.
  6. ____________________________________________________________________________
  7.  
  8.         ATool is an application launcher. It 's main use is, to provide you
  9. an easy way of accessing programs ( and not only! ) that are hard to find
  10. each time they are needed.  In other words it substitutes several mouse
  11. clicks and key-presses into a single menu selection.
  12.  
  13.  
  14. 2. How it works.
  15. ____________________________________________________________________________
  16.  
  17.         When you run ATool, an iconbar is displayed at the top of the
  18. screen. This iconbar works in an about similar way to the standard
  19. Archimedes iconbar. It can contain tool icons, describing areas you want to
  20. have on it, that can be plain text or sprites, large or small. The first
  21. toolicon on the left is the master tool icon, which has the main menu of the
  22. application. This is the only icon that is not user editable. User can
  23. create as many new areas (icons) as he wants and edit them by choosing the
  24. Edit Area menu item on the mastertool icon menu. Areas have an icon on the
  25. iconbar, and menus that contain the area items. These menus appear on Menu
  26. mouse-clicks and can be fully functional Archimedes menus, containing
  27. submenus, shaded items and dotted lines. Even hot-key definitions of an item
  28. will appear on the menus. It's exactly like pressing menu over an icon on
  29. the Archimedes iconbar, where you have a pop-up menu being displayed and
  30. ready to assist you. In a similar way, you can define several areas (icons)
  31. and menus, suitable to your needs.
  32.  
  33. 2.1. MasterTool icon.
  34. ---------------------
  35.         When clicking Menu on the first icon on the left ( master tool
  36. icon), a menu is displayed with the following entries:
  37.  
  38. -Info...................= general information dialogue box.
  39. -Options................= several program options.
  40.         -Set CSD........= when selected means, activate the hot-key for
  41.                           setting CSD (default hot-key is Ctrl-Tab). When
  42.                           you press Ctrl-Tab over a filer directory, CSD is
  43.                           the set to this directory.
  44.         -Hot Keys.......= when selected means that hot-keys are enabled.
  45.         -No Beep........= when selected means that never a beep sound would
  46.                           be generated.
  47.         -No Menu Titles.= when selected means that menus will have no menu
  48.                           titles (active when ATool is loaded).
  49.         -Verbose........= when selected on serious actions yes/no prompts
  50.                           appear.
  51.         -Small Icons....= when selected, the iconbar consists of small
  52.                           icons. (active when ATool is loaded)
  53.         -Iconbar Tool...= when selected, an icon is placed on the iconbar
  54.                    diplaying the free memory or the time.
  55.                    (active when ATool is loaded)
  56.         -Save options...= when selected it saves the current option
  57.                           settings.
  58. -Mouse Step.............= the sub-menu can take a value for a new mouse step
  59.                           (1..9).
  60. -Kill Module............= the sub-menu contains a list of the modules in the
  61.                           RMA. Selecting one of the modules in the list
  62.                           will remove it from the RMA.
  63. -Edit Area..............= Opens the window where you can edit the tool data.
  64.                           See Drawfile 'Manual_2' for detailed description.
  65. -Quit...................= Terminates ATool!
  66.  
  67.         Another hot-key provided is the popup key (default: shift-F11), which
  68. pops the ATool iconbar back/front. This hot-key and the CSD hot-key, are user
  69. defined. The definitions are in the application's Messages textfile. In
  70. Messages file is defined also the font used on Iconbar Tool. The default is
  71. 'Homerton.Medium.Oblique'.
  72.  
  73.         If you have so many icons that fill all the icon bar and extend
  74. outside of the screen area, you can scroll left/right the icons by pressing
  75. Ctrl-LArrow/Ctrl-RArrow.
  76.  
  77.  
  78. 2.2. Edit Area.
  79. ---------------
  80.         Selecting 'Edit Area' on the mastertool icon's menu, a dialogue box
  81. opens, where you can edit all the user areas and their contents. When you
  82. choose this menu item for the first time, everything is blank. You can see
  83. that the window is divided into three parts:
  84.  
  85.  -Area
  86.         = actions on areas (icons on the iconbar)
  87. You can enter a new name on the writable icon and then click on 'Create' to
  88. make a new area, or click on 'Update' to change its name. In order to delete
  89. the whole area click on 'Delete' icon. All newly created areas are appended
  90. to the end. If you want to create an area before the current one, click on
  91. 'Insert' icon.
  92.  
  93.  The current area is shown if any. Pressing 'left/right' arrow icons you
  94. can set the current area. An area by default will appear on the ATool bar as
  95. a text icon with the area's name, but if you put a sprite in the 'Sprites'
  96. file inside the application directory, with the same name as the area, then
  97. instead of a text icon you will have a sprite icon representing the area.
  98. The small iconbar sprites should be named as '~area_name' and the large
  99. iconbar sprites as 'area_name'. If large sprites don't exist and you select
  100. the large iconbar, then the small sprites are used. Othewise icons will
  101. contain only text.
  102.  
  103.  -Item
  104.         = actions on area items.
  105. You can enter a new item by typing it's name and action, or by dragging an
  106. object from the filer. For example, if you drag an application from the
  107. filer, its name is inserted and the action goes 'Filer_Run ..application
  108. path..Name', eg. 'Filer_Run ADFS::4.$.!System'. You can then 'append' this
  109. item to the end of the menu of the current area, or 'insert' it before the
  110. current item, update the current item and 'delete' it. Selecting 'Dot', a
  111. dotted line will separate this item from the previous one. Selecting
  112. 'Shade', this item will appear shaded. A click on sort will sort all the
  113. items in the current area. On HotKey icon you can insert a letter from A-Z
  114. which will be the hot-key that you can press instead of selecting this item
  115. from the area menu. For example if you enter 'E' as a hot-key for the !Edit
  116. application, pressing Control-E will do the action for !Edit. (Note that if
  117. a window owns the caret, you can press Alt-Control-E in order to avoid Wimp
  118. capturing the key press). Pressing 'up/down' arrow icons you set the current
  119. menu item of the area.
  120.  
  121.  -SubMenu
  122.         = actions on submenu items.
  123. You can define an item as a submenu of the current area menu by selecting
  124. the submenu option. Pressing 'left/right' arrow icons you move into the
  125. inner/outter area menu. Eg. to make 'Item 2' as a submenu in the structure
  126.  
  127. +------+                    +------+
  128. |Item 1|                    |Item 1+------+
  129. |Item 2|         --->       |Item 2|Item 4|
  130. |Item 3|                    |Item 3|Item 5|
  131. +------+                    +------+Item 6|
  132.                                    +------+
  133.  
  134. you Click on 'Up Item/Down Item' arrow icons, until you have 'Item 2' as the
  135. current item. Then Click on the 'Submenu' option icon and turn it on, and
  136. Click on 'Update Item'.
  137. Clicking on 'Submenu Right' arrow icon, the Submenu field turns into 'Item
  138. 2', which means that the current area you are editing has become the submenu
  139. 'Item 2'. Now you can add items to this submenu with the same way you add
  140. items to the main area menu.   
  141.  
  142.  If you want to start from the beginning a new structure, you can just
  143. delete the file named 'Pathdata' inside the application directory.
  144.  
  145. 3. Technical details.
  146. ____________________________________________________________________________
  147.  
  148.         The program is written in C. This means mainly speed. It uses idle
  149. polling in such a way that it takes a little CPU time. Maximum number of
  150. areas and items are limited only by available memory. The code is much
  151. smaller than the same code compiled with RiscOSLib because I'm using my own
  152. RiscOS Library. Both, the Library and the program, are error free in this
  153. version, as far as I know. The application is RO2 compatible! I have
  154. developed it on RO3 and RO3.5 (It now works on RPC) but nothing seems to be
  155. incombatible with RO2.
  156.  
  157.  
  158. 4. Present/Future.
  159. ____________________________________________________________________________
  160.  
  161. I'm planning to improve ATool, with more reasonable and really helpful
  162. features. One thing I hate on professional (or not) applications is code
  163. that is useless, slow and with no standards.
  164.  
  165. Features planned for the future:
  166.         - Relocatable module version (shortly)
  167.         - Read-only version for networks, schools etc
  168.         - Modular approach to include/discard tools like Artworks
  169.  
  170.  
  171. 5. How to get a full working copy of ATool
  172. ____________________________________________________________________________
  173.  
  174. To do that you have to send an amount equal to ú20 (twenty english pounds)
  175. to the address below. In a few days you will receive the full working copy
  176. of ATool and also be included in our list for later upgrades. Cheques should
  177. be issued for 'Anthony Plassaras'.
  178.  
  179.  
  180. 6. Contact address
  181. ____________________________________________________________________________
  182.  
  183.  
  184. Archimedes Was Greek,
  185. Anthony Plassaras
  186. 13-15 Xiromerou St.
  187. 11526 Athens
  188. GREECE
  189.  
  190. email: awg@ars.ath.forthnet.gr
  191. fax: ++30 1 6494079
  192.